Merge extended XML documentation. - #389
Open
Red-K0 wants to merge 6 commits into
Open
Conversation
- Added significant amounts of documentation to RestClient, channel and message types, and more. - Added some missing / newly-added properties and JSON objects. - Renamed certain flag values for more consistent styling. - Obsoleted certain deprecated properties. - Added some missing flags.
|
The documentation preview is available at https://preview.netcord.dev/389. |
KubaZ2
requested changes
Jul 19, 2026
KubaZ2
left a comment
KubaZ2
left a comment
Member
There was a problem hiding this comment.
Thanks for this huge PR! For now I reviewed everything up to UserActivityFlags.
KubaZ2
reviewed
Jul 31, 2026
KubaZ2
reviewed
Aug 1, 2026
KubaZ2
reviewed
Aug 1, 2026
KubaZ2
reviewed
Aug 1, 2026
KubaZ2
reviewed
Aug 1, 2026
KubaZ2
reviewed
Sep 7, 2026
| public int Slowmode => _jsonModel.Slowmode.GetValueOrDefault(); | ||
|
|
||
| /// <summary> | ||
| /// The ID of the channel's parent category. |
Member
There was a problem hiding this comment.
@Red-K0, why was this resolved?
Suggested change
| /// The ID of the channel's parent category. | |
| /// The ID of the channel's parent channel. |
| public static ImageUrl ApplicationIcon(ulong applicationId, string iconHash, ImageFormat format) | ||
| { | ||
| return new($"/app-icons/{applicationId}/{iconHash}", GetFormat(format)); | ||
| return new($"/application-icons/{applicationId}/{iconHash}", GetFormat(format)); |
Member
There was a problem hiding this comment.
I believe app-icons was correct
https://docs.discord.com/developers/reference#image-formatting
| public static ImageUrl ApplicationCover(ulong applicationId, string coverHash, ImageFormat format) | ||
| { | ||
| return new($"/app-icons/{applicationId}/{coverHash}", GetFormat(format)); | ||
| return new($"/application-icons/{applicationId}/{coverHash}", GetFormat(format)); |
| namespace NetCord; | ||
|
|
||
| /// <summary> | ||
| /// Contains resolved information for an interaction's auto-populated selection menus. |
Member
There was a problem hiding this comment.
It is not only for selection menus. It is used for basically all interactions.
Maybe something like this?
Suggested change
| /// Contains resolved information for an interaction's auto-populated selection menus. | |
| /// Contains resolved information for an interaction. |
|
|
||
| /// <summary> | ||
| /// Count of super reactions. | ||
| /// The number of applied ssuper reactions. |
Member
There was a problem hiding this comment.
Suggested change
| /// The number of applied ssuper reactions. | |
| /// The number of applied super reactions. |
| JsonModels.JsonEmoji IJsonModel<JsonModels.JsonEmoji>.JsonModel => jsonModel; | ||
|
|
||
| /// <summary> | ||
| /// <inheritdoc cref="CustomEmoji.Id"/> Can be <see langword="null"/> for standard emoji. |
Member
There was a problem hiding this comment.
I believe it will always be null for standard emoji, currently it isn't that clear.
Suggested change
| /// <inheritdoc cref="CustomEmoji.Id"/> Can be <see langword="null"/> for standard emoji. | |
| /// <inheritdoc cref="CustomEmoji.Id"/> <see langword="null"/> for standard emoji. |
| /// <summary> | ||
| /// Gets the <see cref="ImageUrl"/> of the team's icon. | ||
| /// </summary> | ||
| /// <param name="format">The format of the returned <see cref="ImageUrl"/>. Defaults to <see cref="ImageFormat.Png"/> (or <see cref="ImageFormat.Gif"/> for animated icons).</param> |
Member
There was a problem hiding this comment.
It doesn't default to anything, it is a required parameter
| /// Gets the <see cref="ImageUrl"/> of the team's icon. | ||
| /// </summary> | ||
| /// <param name="format">The format of the returned <see cref="ImageUrl"/>. Defaults to <see cref="ImageFormat.Png"/> (or <see cref="ImageFormat.Gif"/> for animated icons).</param> | ||
| /// <returns>An <see cref="ImageUrl"/> pointing to the team's icon. If the user does not have one set, returns <see langword="null"/>.</returns> |
Member
There was a problem hiding this comment.
Suggested change
| /// <returns>An <see cref="ImageUrl"/> pointing to the team's icon. If the user does not have one set, returns <see langword="null"/>.</returns> | |
| /// <returns>An <see cref="ImageUrl"/> pointing to the team's icon. If the team does not have one set, returns <see langword="null"/>.</returns> |
| public ulong ThreadId => jsonModel.ThreadId; | ||
|
|
||
| /// <summary> | ||
| /// The timetstamp at which the user last joined the thread. |
Member
There was a problem hiding this comment.
Suggested change
| /// The timetstamp at which the user last joined the thread. | |
| /// The timestamp at which the user last joined the thread. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.